home *** CD-ROM | disk | FTP | other *** search
/ Graphics Plus / Graphics Plus.iso / msdos / raytrace / pov / gen / form04a / docs / options.doc < prev    next >
Encoding:
Text File  |  1994-03-04  |  12.8 KB  |  363 lines
  1. Sections:
  2.     OVERVIEW
  3.     COMMAND LINE OPTIONS
  4.     DEFAULTS
  5.  
  6. OVERVIEW
  7.  
  8. Most of the facilities in form can be specified in one of three ways, 
  9.  
  10. 1. Through command line switches, use form -? to get the most
  11.     upto date list of these.
  12.  
  13. 2. Through an environment variable FORM, i.e. if you always use the
  14.     command line switches "-res2 -w" you can use the command 
  15.     "set FORM=-res2 -w" 
  16.  
  17. 3. Through the FORM section of the sstools.ini file, virtually all
  18.     the command line switches have their equivalents in this section.
  19.     They are described below.
  20.  
  21.  
  22. COMMAND LINE OPTIONS
  23.  
  24. A usually full and usually correct set of command line switches can
  25. be obtained by entering FORM -? on the command line. You will want to
  26. redirect the output to a temporary file as there is plenty of it.
  27.  
  28. SSTOOLS.INI
  29.  
  30. The options here are listed with their SSTOOLS.INI equivalent, place
  31. these in the [FORM] section of your sstools.ini file. Form will look
  32. for SSTOOLS.INI in the directory specified by the environment
  33. variable SSTOOLS, then it will look in the same directory as
  34. form.exe, and finally along the path.
  35.  
  36. Screen
  37. ------
  38.  
  39. These command line switches affect how form uses the screen display
  40.  
  41. -q[0|1|2|3|4|5]                                     
  42. quality=[0|1|2|3|4|5]
  43.             Quality, very crude, try it on a single sphere and see 
  44.             what you think. Affects screen and VIVID output.
  45.  
  46. -display[1|2|3|4]
  47. display=[on|off], display_type=[WIREFRAME|FLAT|GOURAUD|PHONG]
  48.         This flag tells FORM to draw your form at the end. 
  49.          This is on by default, there are four drawing styles:
  50.  
  51.          1 : display at end Wireframe
  52.          2 : display at end Flat
  53.          3 : display at end Gouraud(default)
  54.          3 : display at end Phong
  55.  
  56. -k[+-]      
  57. pause=[on|off]
  58.         Pause after each screen display.
  59.  
  60. -spin=number    
  61. COMMAND LINE FLAG only.
  62.                 What do all computer graphics people do with an image
  63.                 when they are bored? They spin it! Give a number and
  64.                 FORM will display (and save if asked) the image so
  65.                 that it turns a full circle in that many frames.
  66.  
  67.                 Not very useful without the -save= and -k- flags
  68.                 if -save specified Files are named with trailing digits, i.e.
  69.                 spin=9    takes save=abcdefgh and produces abcdefg#(.gif)
  70.                 spin=9999 creates abcd####(.gif)
  71.  
  72. -ifp=number     
  73. ifp=number or InterFramePause=number
  74.         pause on text screen between each frame for this long ,
  75.         allows you to read the stats predicting length of time to
  76.         completion. 
  77.     
  78. -angle=number   
  79. view_angle=number
  80.         initial rotation of screen view around y axis
  81.  
  82. -res[1|2|3] 
  83. screen_res=[1|2|3]
  84.          the screen resolution used to display the form.
  85.             1 : screen display is 320x200 (default)
  86.             2 : screen display is one of 640x350, 640x400 or 640x480
  87.                 depending on your video card and available extended memory 
  88.             3 : screen display is one of 800x600, 1024x768 or 1280x1024 
  89.                 depending on your video card and available extended
  90.                 memory.
  91.  
  92. -res=WidthxHeight 
  93.             This allows you to specify a screen resolution
  94.             explicitly. The actual screen resolution used is the
  95.             "best fit". The form will be displayed in the middle of
  96.             the real screen.    
  97.  
  98. -float[+-]      
  99. float_render=[on|off]
  100.             This flag tells FORM to use a floating point scan line 
  101.             conversion method, it improves the quality of the display
  102.             at the expense of speed. Only use on a 486 or when you
  103.             are planning to save high(ish) quality pictures to disk.
  104.  
  105. -vesa       
  106. vesa=[on|off]
  107.             Use a vesa driver if found for Video Control, on by
  108.             default. This switch is provided since the autodetect
  109.             routines crash Windows normally! 
  110.             steps: 
  111.                 1. load your vesa driver if need be
  112.                 2. go into windows (if you want)
  113.                 3. run "form -vesa" (is default) 
  114.  
  115.             There usually isn't any apparent slowdown.
  116.             
  117.             You can use your manufacturer supplied Vesa driver, or a
  118.             public domain one such as "UNIVESA".
  119.  
  120.             While a VESA driver is not required by FORM for most VGA
  121.             cards it is advisable to install one if you have one. For
  122.             example FORM mistakenly thinks that my machine at work
  123.             can use 800x600, but it can't. Installing the supplied
  124.             vesa driver cures this problem and FORM correctly uses
  125.             640x480. Sometimes FORM will crash if running under
  126.             windows, this is caused by the autodetect methods,
  127.             installing a VESA driver before I run up windows cures
  128.             the problem.
  129.  
  130. -skeleton[+|-] (or -skel[+|-])
  131.      displays a bare bones skeleton preview (alpha)
  132.  
  133. -bios[+-]  
  134. Bios=[on|off]
  135.             When this is enabled FORM uses bios to draw to the
  136.             screen, and even uses bios to switch to 320x200. Turn
  137.             this flag off for more speed. You may need to leave this
  138.             flag on if you are having real trouble.
  139.  
  140. -modex
  141. ModeX=[on|off]
  142.             When enabled and -bios is NOT enabled FORM will use a VGA
  143.             ModeX method of accessing a 320x200 screen, this is
  144.             faster than BIOS and a little slower than standard
  145.             access, works on my notebook.
  146.  
  147. Memory
  148. ------
  149. These switches determine how FORM will use your memory
  150.  
  151. -dos[-+]
  152. useDos=[on|off]
  153.      Use DOS memory for Z buffer (fastest)
  154.      not using DOS memory for ZBUFFER @ 320x200 can get round some
  155.      odd memory problems.
  156.  
  157. -ems[-+]
  158. useEMS=[on|off]
  159.      Use EMS memory for Z buffer (next fastest) 
  160.  
  161. -xms[-+]
  162. useXMS=[on|off]
  163.      Use XMS memory for Z buffer (next next fastest)
  164.  
  165. -disk[-+]
  166. useDisk=[on|off]
  167.      Use DISK memory for Z buffer (slowest) 
  168.      WARNING: doesn't check disk space first, just assumes you have a 
  169.      100Gb disk!
  170.  
  171. -cache_lines=<number of lines>
  172. cache_lines=number
  173.      How many lines per disk cache unit (default 10) (not really too useful)
  174.  
  175.  
  176. Output
  177. ------
  178. These switches determine how FORM will save your form to disk.
  179.  
  180. -pov[-|+|1|2|3] 
  181. pov_output=[on|off], pov_type=[UNNESTED|DESTED|DECLARES]
  182.         If enabled FORM will produce a file called TEMP.POV
  183.         suitable for use with formvue.pov and the raytracer POV.
  184.         The output file can be in one of three "styles".
  185.  
  186.      - : no temp.pov output file
  187.      + : produce a temp.pov file
  188.      1 : the form is made of individual objects, there is no heirachy
  189.          of objects, they are all specified relative to "world
  190.          coordinates"
  191.  
  192.      2 : the form is made using composites, there is a strict
  193.          heirachy of objects which matches your input form file. 
  194.  
  195.      3 : the form is made using #declares (default), again there is a
  196.          strict heirachy of objects which matches your input form
  197.          file right down to the names, this file is quite compact
  198.          (relatively speaking), and it is fairly easy to apply
  199.          textures in the right place. This output style can also create
  200.          bounding boxes, speeding up raytracing a few times, although
  201.          I'm informed that POV2 does a better job on its own.
  202.  
  203. -pov_version=[1|2]
  204. pov_version=[1|2]
  205.         change pov version that the  output is intended for only 
  206.         tested version 2 tested lately.
  207.  
  208. -bound_torus[+|-]
  209. bound_torus=[on|off]
  210.         output bounding boxes around toruses
  211.         independant of bounding_boxes flag (invalid for pov1 output)
  212.  
  213. -bounding_boxes[+|-]
  214. bounding_boxes=[on|off]
  215.         output bounding boxes on the objects, applied at every named
  216.         object level.
  217.  
  218. -pov_declare_all_prims[+|-]
  219. pov_declare_all_prims=[on|off]
  220.         use declares for primitives, simplifies changing the basic
  221.         objects in POV.
  222.  
  223. -vivid[-|+|1|2]
  224. vivid_output=[on|off], vivid_type=[UNNESTED,NESTED]
  225.      - : no temp.pov output file
  226.      + : produce a temp.v file
  227.      1 : output file is made of individual objects (can have textures)
  228.      2 : output file is made using include files (NO textures)
  229.  
  230. -dxf[-|+|1|2]
  231.     Don't bother trying this option unless you absolutely must.
  232.  
  233. -plg[-|+]   
  234. plg_output=[on|off]
  235.         If enabled FORM will produce a file called TEMP.PLG
  236.         suitable for use with rend386 software.
  237.      - : no temp.plg output file
  238.      + : produce a temp.plg file
  239.  
  240. -save, -save+, -save+filename, -save=filename, -save-
  241. save=[on|off], save_name=filename
  242.             When enabled FORM will display your form at the end, 
  243.             and save the screen display to a file called TEMP.GIF
  244.             or TEMP.TGA, unless you specify a different filename 
  245.  
  246. -w[+|-]         
  247. SaveBackgroundAsWhite=[on|off]
  248.             save background as white -w[+-] flag
  249.  
  250. -g[+|-]
  251. SaveAs=[GIF|TGA]
  252.          If saving save the screen to a GIF file
  253.  
  254. -t[+|-] 
  255. SaveAs=[GIF|TGA]        
  256.         If saving save the screen to a TGA file
  257.  
  258. -gif87[+|-]
  259. Gif87=[yes|no]
  260.         If saving as GIF save in gif87 format, this doesn't save the form 
  261.         script as a comment.
  262.  
  263. -aspSave[-|+filename|=filename]
  264.                 saves final zbuffer to filename (default "temp.asp")
  265.                 to fully disable use -display- -aspSave- 
  266.  
  267.  
  268. General Switches
  269.  
  270. -path=dir1;dir2...
  271. path=dir1,dir2...
  272.                 Include directories to search for FORM files.
  273.  
  274. -debug          Guess what this does!
  275.  
  276. -dump [-|+]     
  277. Dump=[on|off]
  278.                 Produce a Debug Dump at end
  279.  
  280. -v [-|+]        
  281. verbose=[on|off]
  282.                 Overly Verbose and useless output
  283.  
  284. -update_ini     Form will write back any options that occur after
  285.                 this switch to the [FORM] section of your SSTOOLS.INI   
  286.                 file. 
  287.                 WARNING, may not work!
  288.  
  289. -?              Help
  290.  
  291.  
  292. ==========================================================================
  293.  
  294. DEFAULTS
  295. ========
  296. The default for every flag in FORM is
  297.  
  298. Numbers in brackets indicates default value if turned on using "-option+"
  299.                       
  300.  
  301. Flag                  | default        |  SSTOOLS.INI
  302. ======================#================#====================
  303. Screen  
  304. ------ 
  305. -q                    | 0              |  quality
  306. -display              | on (3)         |  display
  307.                       |                |  display_type=GOURAUD
  308. -k                    | on             |  pause
  309. -spin                 | off            |  -
  310. -ifp                  | 10             |  ifp or InterFramePause
  311. -angle                | 0              |  view_angle
  312. -res                  | 1              |  screen_res
  313. -float                | off            |  float_render
  314. -vesa                 | on             |  Vesa
  315. -skel(eton)           | off            |  -
  316. -bios                 | on             |  useBios
  317. -modex                | off            |  ModeX
  318. -VGA16                | off            |  useVGA (for res2 on laptops etc)
  319.  
  320. Memory  
  321. ------  
  322. -dos                  | on             |  use_dos
  323. -ems                  | on             |  use_ems
  324. -xms                  | on             |  use_xms
  325. -disk                 | on             |  use_disk
  326. -cache_lines          | 10             |  cache_lines
  327.                                           
  328. Mutations  
  329. ---------
  330. -mutate
  331. -mutationLayout
  332.  
  333. Output                                    
  334. ------                                    
  335. -pov                  | off (3)        |  pov_output
  336.                       |                |  pov_type=POV_DECLARES
  337. -pov_version          | 2              |  pov_version
  338. -bound_torus          | off            |  bound_torus
  339. -bounding_boxes       | off            |  bounding_boxes
  340. -pov_declare_all_prims| on             |  pov_declare_all_prims
  341.                       |                |  
  342. -vivid                | off (1)        |  vivid_output
  343.                       |                |  vivid_type=VIVID_UNNESTED
  344. -dxf                  | off (1)        |  dxf_output
  345.                       |                |  dxf_type=DXF_UNNESTED
  346. -plg                  | off            |  plg_output
  347. -save                 | off (temp)     |  save
  348.                       |                |  save_name=temp
  349. -w                    | off            |  SaveBackgroundAsWhite
  350. -g                    | on             |  SaveAs=GIF
  351. -t                    | off            |  SaveAs=TGA
  352. -gif87                | off            |  Gif87=off
  353. -aspSave              | off (temp.asp) |  -
  354.  
  355. General
  356. ------- 
  357. -path                 | empty          |  path
  358. -debug                | off            |  -
  359. -dump                 | off            |  Dump
  360. -v                    | off            |  Verbose
  361. -update_ini           | -              |  -
  362.  
  363. ----------------------------------------------------------------